<?php
/**
 * @author Martin Dougiamas
 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
 * @package moodle multiauth
 *
 * Authentication Plugin: Manual Authentication
 *
 * Just does a simple check against the moodle database.
 *
 * 2006-08-28  File created.
 */

if (!defined('MOODLE_INTERNAL')) {
	die('Direct access to this script is forbidden.');	///  It must be included from a Moodle page
}

require_once($CFG->libdir.'/authlib.php');

/**
 * Manual authentication plugin.
 */
class auth_plugin_manual extends auth_plugin_base {

	/**
	 * Constructor.
	 */
	function auth_plugin_manual() {
		$this->authtype = 'manual';
		$this->config = get_config('auth/manual');
	}

	/**
	 * Returns true if the username and password work and false if they are
	 * wrong or don't exist.
	 *
	 * @param string $username The username (with system magic quotes)
	 * @param string $password The password (with system magic quotes)
	 *
	 * @return bool Authentication success or failure.
	 */
	function user_login ($username, $password) {
		global $CFG;
		if ($user = get_record('user', 'username', $username, 'mnethostid', $CFG->mnet_localhost_id)) {
			return validate_internal_user_password($user, $password);
		}
		return false;
	}

	/**
	 * Updates the user's password.
	 *
	 * called when the user password is updated.
	 *
	 * @param  object  $user		User table object  (with system magic quotes)
	 * @param  string  $newpassword Plaintext password (with system magic quotes)
	 * @return boolean result
	 *
	 */
	function user_update_password($user, $newpassword) {
		$user = get_complete_user_data('id', $user->id);
		return update_internal_user_password($user, $newpassword);
	}

	/**
	 * Returns true if this authentication plugin is 'internal'.
	 *
	 * @return bool
	 */
	function is_internal() {
		return true;
	}

	/**
	 * Returns true if this authentication plugin can change the user's
	 * password.
	 *
	 * @return bool
	 */
	function can_change_password() {
		return true;
	}

	/**
	 * Returns the URL for changing the user's pw, or empty if the default can
	 * be used.
	 *
	 * @return string
	 */
	function change_password_url() {
		return '';
	}

	/**
	 * Returns true if plugin allows resetting of internal password.
	 *
	 * @return bool
	 */
	function can_reset_password() {
		return true;
	}

	/**
	 * Prints a form for configuring this authentication plugin.
	 *
	 * This function is called from admin/auth.php, and outputs a full page with
	 * a form for configuring this plugin.
	 *
	 * @param array $page An object containing all the data for this page.
	 */
	function config_form($config, $err, $user_fields) {
		include 'config.html';
	}

	/**
	 * Processes and stores configuration data for this authentication plugin.
	 */
	function process_config($config) {
		return true;
	}

   /**
	 * Confirm the new user as registered. This should normally not be used,
	 * but it may be necessary if the user auth_method is changed to manual 
	 * before the user is confirmed.
	 */
	function user_confirm($username, $confirmsecret = null) {		
		$user = get_complete_user_data('username', $username);

		if (!empty($user)) {
			if ($user->confirmed) {
				return AUTH_CONFIRM_ALREADY;
			} else { 
				if (!set_field("user", "confirmed", 1, "id", $user->id)) {
					return AUTH_CONFIRM_FAIL;
				}
				if (!set_field("user", "firstaccess", time(), "id", $user->id)) {
					return AUTH_CONFIRM_FAIL;
				}
				return AUTH_CONFIRM_OK;
			}
		} else  {
			return AUTH_CONFIRM_ERROR;
		}
	}

}

?>
